home *** CD-ROM | disk | FTP | other *** search
/ Aminet 4 / Aminet 4 - November 1994.iso / aminet / comm / cnet / lastcall_82.lha / LastCallers.doc < prev    next >
Text File  |  1994-03-25  |  15KB  |  335 lines
  1.                             LastCallers v8.2
  2.                        For C-Net Amiga ** v3.04+ **
  3.                    Written by Ray Akey (AKA Heavy Metal)
  4.  
  5.        This is an enhanced Last 10 callers program for C-Net Amiga.
  6.  
  7.  
  8.  
  9.  
  10. Current Changes (v8.2)
  11. ---------------
  12. 1. VERBOSE mode got some needed internal attention.
  13. 2. Fixed NOLOGMAINTUSER and LOGMAINTUSER keywords:  were not being recognized
  14.    properly.
  15. 3. sysdata:LastCallersText2 line 46 was displayed for ALL gfx/termwidth types
  16.    rather than choosing the proper line (45-50).  Thanks to PMK on Future
  17.    World for this bug report.
  18. 4. New token types for LastCallersText2:
  19.  
  20.       {ONTIME %s}
  21.       {ONDATE %s}
  22.       {OFFTIME %s}
  23.       {OFFDATE %s}
  24.  
  25. 5. {CALLSTODAY} is now a string type, so the following format is correct:
  26.  
  27.       {CALLSTODAY %s}
  28.  
  29.  
  30.  
  31. Changes v8.1
  32. -----------
  33. 1. {REALNAME} added to the list of possible tokens available for
  34.    LASTCALLERSTEXT2.
  35. 2. The following configuration keywords added.  The following is an exact
  36.    duplicate of explanation for each as found in Last10.cfg:
  37.  
  38.                VERBOSE           -> Verbose (debug) output to user's screen
  39.                                     this option only works if the user has
  40.                                     SYSOP MAINT - otherwise ignored
  41.                NOLOGID x         -> Don't log account x
  42.                NOLOGNAME x       -> don't log handle x
  43.                NOLOGACCESS x     -> don't log access x
  44.  
  45. ;----------- -> SHOWNUM x        -> Show last x callers (this is also used to
  46. ;IF USED,    ->                     determine the number of entries logged to
  47. ;THESE THREE ->                     Last10.data.
  48. ;OPTIONS MUST-> ADJUST x         -> Adjust users TermLength by this number
  49. ;EXIST IN    ->                     (added to facilitate other mods to text)
  50. ;LAST10.CFG  ->                     Increase or decrease until Top Ten fits
  51. ;IN THIS     ->                     on user's screen when using USETERMLEN
  52. ;ORDER!      ->                     default ADJUST = 11.
  53. ;----------- -> USETERMLEN       -> Use the user's TERMLENGTH to determine
  54. ;----------- ->                     number of last callers to display
  55.  
  56.  
  57.    NOTE: "SHOWNUM x" will always be used to set the number of entries that
  58.         will be logged into the last ten data.  For this reason, if SHOWNUM
  59.         is not configured, the user will see ONLY the last ten callers by
  60.         default as that is how many callers will be logged to last 10 data
  61.         in that case.  Also note that the USETERMLEN option must exist
  62.         before (above) the SHOWNUM x option in this cfg file, if that option
  63.         is used.  Also if "ADJUST x" is to be used, it must exist above
  64.         USETERMLEN.
  65.  
  66.          ie. If SHOWNUM 40 is set, and a user's terminal length is set
  67.         to 23, the user may only see the last 19 callers but 40 entries
  68.         will actually exist in the Last10.data
  69.  
  70. Changes v8.0
  71. -----------
  72. 1.  Token interpreter added that allows you to choose exactly what you want
  73.     displayed and how you want it displayed!!
  74.  
  75.    Choice of the following currently existing variables:
  76.  
  77.    USER Variable Name       TYPE            Explanation
  78.    ------------------------ --------------- ---------------------------------
  79.    {HANDLE}                 %s              user's handle (doh)
  80.    {REALNAME}               %s              user's real name
  81.    {CITY}                   %s              user's City & State
  82.    {COUNTRY}                %s              user's Country
  83.    {PORTNUM}                %d              Port number user occupied
  84.    {BAUD}                   %d              user's login baud
  85.    {CALLERNUM}              %ld             the caller number the user was
  86.    {DOWNFILES}              %d              the number of files users has dloaded
  87.    {DOWNK}                  %ld             number of KILObytes user has dloaded
  88.    {UPFILES}                %d              the number of files users has uploaded
  89.    {UPK}                    %ld             number of KILObytes user has uploaded
  90.    {MINSONLINE}             %d              number of minutes user was online
  91.    {CALLSTODAY}             %d              Number of calls the user made to the
  92.                                             system (the day he/she logged in!)
  93.    {TOTALCALLS}             %d              total number of calls the user has
  94.                                             made to the system
  95.    {AGCNAME}                %s              user's access group name
  96.    {PUBMSGS}                %d              number of PUBLIC msgs user made to
  97.                                             the system
  98.    {PRIMSGS}                %d              number of PRIVATE msgs user made to
  99.                                             the system
  100.    {BANNER}                 %s              Users system banner
  101.    {ACCOUNTNUM}             %d              users account number
  102.  
  103.  
  104.    SYSTEM STAT Variable Name    TYPE SPECIFIER  Explanation
  105.    ---------------------------- --------------- -----------------------------
  106.    {TSYSCALLS}                  %ld             Calls to the system TODAY
  107.    {TSYSUPF}                    %d              number of files uploaded to
  108.                                                 the system today
  109.    {TSYSUPK}                    %ld             number of K-bytes upload today
  110.    {TSYSDNF}                    %d              number of files downloaded
  111.                                                 today
  112.    {TSYSDNK}                    %ld             number of K-BYTES downloaded 
  113.                                                 today
  114.    {SSYSCALLS}                  %ld             TOTAL calls to the system
  115.    {SSYSUPF}                    %ld             TOTAL files uploaded
  116.    {SSYSUPK}                    %ld             Total K-bytes uploaded/1000
  117.    {SSYSDNF}                    %ld             total files downloaded
  118.    {SSYSDNK}                    %ld             total K-bytes downloaded/1000
  119.    {YSYSCALLS}                  %ld             calls to the system testerday
  120.    {YSYSUPF}                    %ld             files uploaded yesterday
  121.    {YSYSUPK}                    %ld             K-bytes uploaded yesterday
  122.    {YSYSDNF}                    %ld             files downloaded yesterday
  123.    {YSYSDNK}                    %ld             K-bytes downloaded yesterday
  124.    {AUTHOR}                     %s              ME! (Heavy Metal/NORML)
  125.    {ACTION}                     %s              String of actions the user
  126.                                                 performed online
  127.  
  128.    The format for these variables is as follows:
  129.  
  130.    {AUTHOR %s}
  131.  
  132.     ^^^^^^ ^^
  133.       |     |
  134.       |     c formatting specifier
  135.       variable name
  136.  
  137.    Your variable name MUST be enclosed in braces.
  138.  
  139.    More about C formatting specifiers:
  140.  
  141.       You may also use any of the following formats for your C specifiers
  142.  
  143.          %12s                Means print the variable as a STRING in a field
  144.                              of 12 characters RIGHT justified and padded with
  145.                              spaces.
  146.          %-12s               Means print the variable as a STRING in a field
  147.                              of 12 characters LEFT justified and padded with
  148.                              spaces
  149.          %12.11s             Means print the variable as a STRING in a field
  150.                              of 12 characters RIGHT justified and padded with
  151.                              spaces and if the string is longer than 11
  152.                              characters, truncate it at the 11th character
  153.          %5d                 print the variable as an integer in a field of
  154.                              width 5.
  155.          %4ld                Print the variable as a LONG integer in a field
  156.                              of width 4.  If you are getting strange values
  157.                              with %d, try %ld
  158.  
  159.    If you have any suggestions on other variables you would like to see
  160.    added or if you have suggestions, please let me know.
  161.  
  162.  
  163. Changes v7.4
  164. ------------
  165. 1.  LastCallers now logs the last callers from bottom to top.
  166.     The last caller is displayed at the TOP of the last 10 display.
  167. 2.  NOLOGMAINTUSER fixed.  Previously, this did not work properly.
  168.  
  169.  
  170. Changes v7.2
  171. ------------
  172. 1.  Small bug fix involving display of file/byte stats.
  173. 2.  Recompiled with CNet v3.04 headers
  174.  
  175. Changes from v7.1
  176. ------------------
  177. 1.  Can now be used in ANY CLI/Shell -> Caller info only displayed. No
  178.                                         system stats are yet available here.
  179.                                         No last caller data is updated.
  180.  
  181. Changes from V7.0
  182. -----------------
  183. 1.  Now PURE.  Both modules can be made resident.
  184.  
  185.     Use "RESIDENT PFILES:LASTCALLERS PFILES:LASTCALLERS"
  186.     and "RESIDENT PFILES:LASTCALLERSUPDATE PFILES:LASTCALLERSUPDATE"
  187.     in your startups to make either of these programs resident.
  188.  
  189. 2.  It is Now possible to turn OFF/ON sysop account logging and
  190.     any other maint (SYSOP MAINTENANCE priviledge) user.
  191.     To use these options, create the file SYSDATA:LAST10.CFG and place
  192.     any of the following keywords in that file:
  193.  
  194.       NOLOGSYSOP         -> Turns OFF (disbales) logging of account #1 to
  195.                             last 10.
  196.       LOGSYSOP           -> Turns ON (enables) logging of account #1 in last
  197.                             10.
  198.       NOLOGMAINTUSER     -> Turns OFF logging of any users with MAINT (except
  199.                             account #1).
  200.       LOGMAINTUSER       -> Turns ON logging of maint users (except account
  201.                             #1).
  202.  
  203.    NOTE: any commented lines must BEGIN with a semi-colon (;).
  204.          an example LAST10.CFG has been provided.
  205.  
  206.  
  207. Changes from 6.0
  208. ----------------
  209. 1. Major changes (again) for this version.  You must (if they exist) delete:
  210.  
  211.    SYSDATA:LAST10.DATA
  212.          &
  213.    SYSDATA:LAST10.STAT
  214.  
  215. 2. A few DAILY items are kept track of now also:
  216.  
  217.    1:  Calls today.
  218.    2:  Upload Files Today.
  219.    3:  Upload KB Today.
  220.    4:  Dload Files Today.
  221.    5:  Dload KB Today.
  222.  
  223.    All of these "daily" variables are reset each day, after midnight when
  224.    "LastCallersUpdate" is next ran.
  225.  
  226. 3. All text is still capable of being edited so I will leave you here.  Make sure
  227.    you read the "Changes from 5.0" below the sample output, if you are running
  228.    a version that doesn't include the LastCallersUpdate program.
  229.  
  230. 5. The display has been COMPLETELY reworked this time allowing more important
  231.    info to be displayed for each last caller.  Here is a sample output (sans
  232.    colour of course and using IBM GFX):
  233. ---
  234.  
  235.   <>*<>              C-Net LastCallers - Heavy Metal/NORML              <>*<>
  236.  
  237.   P# Handle/Name           Actions Bd  From                 Min   UpK   DnK
  238.   ÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄ 
  239.    1 Juan Epstein          [----N]  96 Windsor, ON            1     0     0
  240.    1 Dr.doom               [M---N] 144 Windsor Ontario        7     0     0
  241.    1 Black Light           [----N] 144 Windsor,Ontario       14     0     0
  242.    2 Eric                  [----N]  24 Aburg, ON              1     0     0
  243.    1 Supreme Wizard        [---DN] 144 Windsor, ON           47     0  4406
  244.    1 Maxcon                [----N] 144 Windsor, ON            0     0     0
  245.    1 The Urscumug          [M---N]  24 Windsor, ON            7     0     0
  246.    1 Outlaw                [M---N]  96 Windsor, ON            9     0     0
  247.    1 Foxx/norml            [----N] 144 Windsor, ON            2     0     0
  248.    3 Baroness              [-P---]  96 Windsor, ON           12     0     0
  249.   ÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄ
  250.      [M]sg Left                                             [C]arrier Lost
  251.      [P]aged Sysop          [U]L'ed           [D]L'ed       [N]ormal Off
  252.  
  253.                               Calls   ULf    UpK     DLf    DnK
  254.                       Today:      0     0      0       0      0
  255.                       ToTal:  42715  1711   455K   10863  2662K
  256. ---
  257.  
  258.  
  259. Changes from 5.0
  260. ----------------
  261.  1.   Almost all text is now external, in two files:
  262.  
  263.                           systext:lastcallerstext
  264.                                      &
  265.                           systext:lastcallers.msg
  266.  
  267.       "lastcallers.msg" is just a menu type TEXT file that explains what the
  268.     "action" flags mean.
  269.  
  270.       "lastcallerstext" is the file which contains the actual graphics
  271.     and text/C formatting that is seen when LastCallers is viewed.  Edit this
  272.     file if you wish to customize the Last callers display.  There are
  273.     graphics sections for 40/80 column ASCII, 40/80 column C64 GFX, and 40/80
  274.     column IBM GFX.  The first is IBM, 2nd is CBM and the last but not least,
  275.     ASCII.
  276.  
  277.  2.   The action flags - These are a set of 9 letters which stand for the 
  278.     following things which a user has done while online:
  279.  
  280.                            D = Downloaded
  281.                            U = Uploaded
  282.                            M = Left a message (Mail, Post, Response)
  283.                            P = Paged Sysop
  284.                            C = Lost Carrier
  285.                            N = Normal Logoff
  286.  
  287.  3.   The main display is updated at login, so that the user appears in
  288.     the lastcallers display, in the correct order of logins.  To facilitate
  289.     the updating of the caller display, and to incorporate any actions that
  290.     a user performs while online, the program "LastCallersUpdate" has been
  291.     written.  This C-Net Pfile must be configured to run when a user logs off.
  292.     To do this, add the following command to line 99 of BBSTEXT:
  293.  
  294.     #2pfiles:LastCallersUpdate}
  295.  
  296.     ^
  297.     |
  298.     CTRL-Q
  299.  
  300.  
  301. Operation:
  302. ----------
  303.    The display is nicely formatted and displays correctly for all terminal types
  304. and graphics settings of C-Net Amiga..  It is an all-in-one program where there
  305. is nothing for you to create.  Everything (creation of the data file, updating
  306. last 10 and displaying last 10) is done in a single program.
  307.  
  308. Installation:
  309. -------------
  310.  1.   Copy LastCallers & LastCallersUpdate to your Pfiles.
  311.  2.   add the following text to your SYSTEM:SYS.WELCOME file or another location
  312.       where you would like it displayed..  possibly BBSTEXT but be careful
  313.       where you put it as in some areas of BBSTEXT, the user's handle is not
  314.       know and will show in the Top Ten as <Logon>.  If you put it in
  315.       sys.welcome, it is guaranteed to work FLAWLESSLY.
  316.  
  317.          \#2pfiles:LastCallers\
  318.  
  319.  3.   Add the following text to line 99 of BBSTEXT:
  320.  
  321.          #2pfiles:LastCallersUpdate}
  322.  
  323.          ^
  324.          |
  325.          CTRL-Q
  326.  
  327.  3.   That's it.. When the file is run for the first time, it will create the
  328.       data file and keep it updated on succesive calls.
  329.  
  330.  --------------------------------------------------------------------------
  331.    Call:  THE METAL SHOPPE BBS for more C-Net Pfiles by myself and others
  332.    (519) 256-0278 -- 2400-19200 Baud --           Windsor, Ontario Canada
  333.    (519) 255-7378 -- 1200-2400  Baud --       METAL SOFTWARE HEADQUARTERS
  334.  --------------------------------------------------------------------------
  335.